Skip to content

Enforcing Markdown rules, list item indentation, cleaning up extra spaces (MD007, MD012). #4079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

dhtclk
Copy link
Collaborator

@dhtclk dhtclk commented Jul 14, 2025

Docs repo needs to have some foundational standards to ensure future quality and consistency. As such, sweeping changes to allow enforcement of certain mark down rules have been added, consisting of tabbing and spacing issues. There will have to be an open eye for some unintended side effects, but the impact of these changes should be minimal given the nature of the changes which mostly involve markdown formatting. No actual text changes where implemented.

@dhtclk dhtclk requested review from a team as code owners July 14, 2025 19:14
@dhtclk dhtclk requested a review from iskakaushik July 14, 2025 19:14
@dhtclk dhtclk linked an issue Jul 14, 2025 that may be closed by this pull request
Copy link

vercel bot commented Jul 14, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clickhouse-docs ❌ Failed (Inspect) Jul 18, 2025 6:23pm
clickhouse-docs-ru ❌ Failed (Inspect) Jul 18, 2025 6:23pm
clickhouse-docs-zh ❌ Failed (Inspect) Jul 18, 2025 6:23pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
clickhouse-docs-jp ⬜️ Ignored (Inspect) Jul 18, 2025 6:23pm

@Blargian
Copy link
Member

Inspected roughly half of the pages and it all looks good. The only strange things I see reoccurring are:

The spacing between the end of a list and certain header elements looks weird:

Screenshot 2025-07-14 at 22 24 56

The gap between bullets in a few places looks a little too wide (maybe it's just me?):

Screenshot 2025-07-14 at 22 19 20

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Spacing after list items
2 participants